home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / gcc_260.zip / gcc_260 / gcc.info-8 (.txt) < prev    next >
GNU Info File  |  1994-07-14  |  51KB  |  939 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.54 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Published by the Free Software Foundation 675 Massachusetts Avenue
  5. Cambridge, MA 02139 USA
  6.    Copyright (C) 1988, 1989, 1992, 1993 Free Software Foundation, Inc.
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided also
  12. that the sections entitled "GNU General Public License" and "Protect
  13. Your Freedom--Fight `Look And Feel'" are included exactly as in the
  14. original, and provided that the entire resulting derived work is
  15. distributed under the terms of a permission notice identical to this
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that the sections entitled "GNU General Public
  19. License" and "Protect Your Freedom--Fight `Look And Feel'", and this
  20. permission notice, may be included in translations approved by the Free
  21. Software Foundation instead of in the original English.
  22. File: gcc.info,  Node: Case Ranges,  Next: Function Attributes,  Prev: Cast to Union,  Up: C Extensions
  23. Case Ranges
  24. ===========
  25.    You can specify a range of consecutive values in a single `case'
  26. label, like this:
  27.      case LOW ... HIGH:
  28. This has the same effect as the proper number of individual `case'
  29. labels, one for each integer value from LOW to HIGH, inclusive.
  30.    This feature is especially useful for ranges of ASCII character
  31. codes:
  32.      case 'A' ... 'Z':
  33.    *Be careful:* Write spaces around the `...', for otherwise it may be
  34. parsed wrong when you use it with integer values.  For example, write
  35. this:
  36.      case 1 ... 5:
  37. rather than this:
  38.      case 1...5:
  39. File: gcc.info,  Node: Cast to Union,  Next: Case Ranges,  Prev: Labeled Elements,  Up: C Extensions
  40. Cast to a Union Type
  41. ====================
  42.    A cast to union type is similar to other casts, except that the type
  43. specified is a union type.  You can specify the type either with `union
  44. TAG' or with a typedef name.  A cast to union is actually a constructor
  45. though, not a cast, and hence does not yield an lvalue like normal
  46. casts.  (*Note Constructors::.)
  47.    The types that may be cast to the union type are those of the members
  48. of the union.  Thus, given the following union and variables:
  49.      union foo { int i; double d; };
  50.      int x;
  51.      double y;
  52. both `x' and `y' can be cast to type `union' foo.
  53.    Using the cast as the right-hand side of an assignment to a variable
  54. of union type is equivalent to storing in a member of the union:
  55.      union foo u;
  56.      ...
  57.      u = (union foo) x  ==  u.i = x
  58.      u = (union foo) y  ==  u.d = y
  59.    You can also use the union cast as a function argument:
  60.      void hack (union foo);
  61.      ...
  62.      hack ((union foo) x);
  63. File: gcc.info,  Node: Function Attributes,  Next: Function Prototypes,  Prev: Case Ranges,  Up: C Extensions
  64. Declaring Attributes of Functions
  65. =================================
  66.    In GNU C, you declare certain things about functions called in your
  67. program which help the compiler optimize function calls and check your
  68. code more carefully.
  69.    The keyword `__attribute__' allows you to specify special attributes
  70. when making a declaration.  This keyword is followed by an attribute
  71. specification inside double parentheses.  Four attributes, `noreturn',
  72. `const', `format', and `section' are currently defined for functions.
  73. Other attributes, including `section' are supported for variables
  74. declarations (*note Variable Attributes::.).
  75. `noreturn'
  76.      A few standard library functions, such as `abort' and `exit',
  77.      cannot return.  GNU CC knows this automatically.  Some programs
  78.      define their own functions that never return.  You can declare them
  79.      `noreturn' to tell the compiler this fact.  For example,
  80.           void fatal () __attribute__ ((noreturn));
  81.           
  82.           void
  83.           fatal (...)
  84.           {
  85.             ... /* Print error message. */ ...
  86.             exit (1);
  87.           }
  88.      The `noreturn' keyword tells the compiler to assume that `fatal'
  89.      cannot return.  It can then optimize without regard to what would
  90.      happen if `fatal' ever did return.  This makes slightly better
  91.      code.  More importantly, it helps avoid spurious warnings of
  92.      uninitialized variables.
  93.      Do not assume that registers saved by the calling function are
  94.      restored before calling the `noreturn' function.
  95.      It does not make sense for a `noreturn' function to have a return
  96.      type other than `void'.
  97.      The attribute `noreturn' is not implemented in GNU C versions
  98.      earlier than 2.5.  An alternative way to declare that a function
  99.      does not return, which works in the current version and in some
  100.      older versions, is as follows:
  101.           typedef void voidfn ();
  102.           
  103.           volatile voidfn fatal;
  104. `const'
  105.      Many functions do not examine any values except their arguments,
  106.      and have no effects except the return value.  Such a function can
  107.      be subject to common subexpression elimination and loop
  108.      optimization just as an arithmetic operator would be.  These
  109.      functions should be declared with the attribute `const'.  For
  110.      example,
  111.           int square (int) __attribute__ ((const));
  112.      says that the hypothetical function `square' is safe to call fewer
  113.      times than the program says.
  114.      The attribute `const' is not implemented in GNU C versions earlier
  115.      than 2.5.  An alternative way to declare that a function has no
  116.      side effects, which works in the current version and in some older
  117.      versions, is as follows:
  118.           typedef int intfn ();
  119.           
  120.           extern const intfn square;
  121.      Note that a function that has pointer arguments and examines the
  122.      data pointed to must *not* be declared `const'.  Likewise, a
  123.      function that calls a non-`const' function usually must not be
  124.      `const'.  It does not make sense for a `const' function to return
  125.      `void'.
  126. `format (ARCHETYPE, STRING-INDEX, FIRST-TO-CHECK)'
  127.      The `format' attribute specifies that a function takes `printf' or
  128.      `scanf' style arguments which should be type-checked against a
  129.      format string.  For example, the declaration:
  130.           extern int
  131.           my_printf (void *my_object, const char *my_format, ...)
  132.                 __attribute__ ((format (printf, 2, 3)));
  133.      causes the compiler to check the arguments in calls to `my_printf'
  134.      for consistency with the `printf' style format string argument
  135.      `my_format'.
  136.      The parameter ARCHETYPE determines how the format string is
  137.      interpreted, and should be either `printf' or `scanf'.  The
  138.      parameter STRING-INDEX specifies which argument is the format
  139.      string argument (starting from 1), while FIRST-TO-CHECK is the
  140.      number of the first argument to check against the format string.
  141.      For functions where the arguments are not available to be checked
  142.      (such as `vprintf'), specify the third parameter as zero.  In this
  143.      case the compiler only checks the format string for consistency.
  144.      In the example above, the format string (`my_format') is the second
  145.      argument of the function `my_print', and the arguments to check
  146.      start with the third argument, so the correct parameters for the
  147.      format attribute are 2 and 3.
  148.      The `format' attribute allows you to identify your own functions
  149.      which take format strings as arguments, so that GNU CC can check
  150.      the calls to these functions for errors.  The compiler always
  151.      checks formats for the ANSI library functions `printf', `fprintf',
  152.      `sprintf', `scanf', `fscanf', `sscanf', `vprintf', `vfprintf' and
  153.      `vsprintf' whenever such warnings are requested (using
  154.      `-Wformat'), so there is no need to modify the header file
  155.      `stdio.h'.
  156. `section ("section-name")'
  157.      Normally, the compiler places the code it generates in the `text'
  158.      section.  Sometimes, however, you need additional sections, or you
  159.      need certain particular functions to appear in special sections.
  160.      The `section' attribute specifies that a function lives in a
  161.      particular section.  For example, the declaration:
  162.           extern void foobar (void) __attribute__ ((section (".init")));
  163.      puts the function `foobar' in the `.init' section.
  164.      Some file formats do not support arbitrary sections so the
  165.      `section' attribute is not available on all platforms.  If you
  166.      need to map the entire contents of a module to a particular
  167.      section, consider using the facilities of the linker instead.
  168.    You can specify multiple attributes in a declaration by separating
  169. them by commas within the double parentheses or by immediately
  170. following an attribute declaration with another attribute declaration.
  171.    Some people object to the `__attribute__' feature, suggesting that
  172. ANSI C's `#pragma' should be used instead.  There are two reasons for
  173. not doing this.
  174.   1. It is impossible to generate `#pragma' commands from a macro.
  175.   2. There is no telling what the same `#pragma' might mean in another
  176.      compiler.
  177.    These two reasons apply to almost any application that might be
  178. proposed for `#pragma'.  It is basically a mistake to use `#pragma' for
  179. *anything*.
  180. File: gcc.info,  Node: Function Prototypes,  Next: Dollar Signs,  Prev: Function Attributes,  Up: C Extensions
  181. Prototypes and Old-Style Function Definitions
  182. =============================================
  183.    GNU C extends ANSI C to allow a function prototype to override a
  184. later old-style non-prototype definition.  Consider the following
  185. example:
  186.      /* Use prototypes unless the compiler is old-fashioned.  */
  187.      #if __STDC__
  188.      #define P(x) x
  189.      #else
  190.      #define P(x) ()
  191.      #endif
  192.      
  193.      /* Prototype function declaration.  */
  194.      int isroot P((uid_t));
  195.      
  196.      /* Old-style function definition.  */
  197.      int
  198.      isroot (x)   /* ??? lossage here ??? */
  199.           uid_t x;
  200.      {
  201.        return x == 0;
  202.      }
  203.    Suppose the type `uid_t' happens to be `short'.  ANSI C does not
  204. allow this example, because subword arguments in old-style
  205. non-prototype definitions are promoted.  Therefore in this example the
  206. function definition's argument is really an `int', which does not match
  207. the prototype argument type of `short'.
  208.    This restriction of ANSI C makes it hard to write code that is
  209. portable to traditional C compilers, because the programmer does not
  210. know whether the `uid_t' type is `short', `int', or `long'.  Therefore,
  211. in cases like these GNU C allows a prototype to override a later
  212. old-style definition.  More precisely, in GNU C, a function prototype
  213. argument type overrides the argument type specified by a later
  214. old-style definition if the former type is the same as the latter type
  215. before promotion.  Thus in GNU C the above example is equivalent to the
  216. following:
  217.      int isroot (uid_t);
  218.      
  219.      int
  220.      isroot (uid_t x)
  221.      {
  222.        return x == 0;
  223.      }
  224. File: gcc.info,  Node: Dollar Signs,  Next: Character Escapes,  Prev: Function Prototypes,  Up: C Extensions
  225. Dollar Signs in Identifier Names
  226. ================================
  227.    In GNU C, you may use dollar signs in identifier names.  This is
  228. because many traditional C implementations allow such identifiers.
  229.    On some machines, dollar signs are allowed in identifiers if you
  230. specify `-traditional'.  On a few systems they are allowed by default,
  231. even if you do not use `-traditional'.  But they are never allowed if
  232. you specify `-ansi'.
  233.    There are certain ANSI C programs (obscure, to be sure) that would
  234. compile incorrectly if dollar signs were permitted in identifiers.  For
  235. example:
  236.      #define foo(a) #a
  237.      #define lose(b) foo (b)
  238.      #define test$
  239.      lose (test)
  240. File: gcc.info,  Node: Character Escapes,  Next: Variable Attributes,  Prev: Dollar Signs,  Up: C Extensions
  241. The Character ESC in Constants
  242. ==============================
  243.    You can use the sequence `\e' in a string or character constant to
  244. stand for the ASCII character ESC.
  245. File: gcc.info,  Node: Alignment,  Next: Inline,  Prev: Variable Attributes,  Up: C Extensions
  246. Inquiring on Alignment of Types or Variables
  247. ============================================
  248.    The keyword `__alignof__' allows you to inquire about how an object
  249. is aligned, or the minimum alignment usually required by a type.  Its
  250. syntax is just like `sizeof'.
  251.    For example, if the target machine requires a `double' value to be
  252. aligned on an 8-byte boundary, then `__alignof__ (double)' is 8.  This
  253. is true on many RISC machines.  On more traditional machine designs,
  254. `__alignof__ (double)' is 4 or even 2.
  255.    Some machines never actually require alignment; they allow reference
  256. to any data type even at an odd addresses.  For these machines,
  257. `__alignof__' reports the *recommended* alignment of a type.
  258.    When the operand of `__alignof__' is an lvalue rather than a type,
  259. the value is the largest alignment that the lvalue is known to have.
  260. It may have this alignment as a result of its data type, or because it
  261. is part of a structure and inherits alignment from that structure.  For
  262. example, after this declaration:
  263.      struct foo { int x; char y; } foo1;
  264. the value of `__alignof__ (foo1.y)' is probably 2 or 4, the same as
  265. `__alignof__ (int)', even though the data type of `foo1.y' does not
  266. itself demand any alignment.
  267.    A related feature which lets you specify the alignment of an object
  268. is `__attribute__ ((aligned (ALIGNMENT)))'; see the following section.
  269. File: gcc.info,  Node: Variable Attributes,  Next: Alignment,  Prev: Character Escapes,  Up: C Extensions
  270. Specifying Attributes of Variables
  271. ==================================
  272.    The keyword `__attribute__' allows you to specify special attributes
  273. of variables or structure fields.  This keyword is followed by an
  274. attribute specification inside double parentheses.  Four attributes are
  275. currently defined for variables: `aligned', `mode', `packed', and
  276. `section'.  Other attributes are defined for functions, and thus not
  277. documented here; see *Note Function Attributes::.
  278. `aligned (ALIGNMENT)'
  279.      This attribute specifies a minimum alignment for the variable or
  280.      structure field, measured in bytes.  For example, the declaration:
  281.           int x __attribute__ ((aligned (16))) = 0;
  282.      causes the compiler to allocate the global variable `x' on a
  283.      16-byte boundary.  On a 68040, this could be used in conjunction
  284.      with an `asm' expression to access the `move16' instruction which
  285.      requires 16-byte aligned operands.
  286.      You can also specify the alignment of structure fields.  For
  287.      example, to create a double-word aligned `int' pair, you could
  288.      write:
  289.           struct foo { int x[2] __attribute__ ((aligned (8))); };
  290.      This is an alternative to creating a union with a `double' member
  291.      that forces the union to be double-word aligned.
  292.      It is not possible to specify the alignment of functions; the
  293.      alignment of functions is determined by the machine's requirements
  294.      and cannot be changed.  You cannot specify alignment for a typedef
  295.      name because such a name is just an alias, not a distinct type.
  296.      The `aligned' attribute can only increase the alignment; but you
  297.      can decrease it by specifying `packed' as well.  See below.
  298.      The linker of your operating system imposes a maximum alignment.
  299.      If the linker aligns each object file on a four byte boundary,
  300.      then it is beyond the compiler's power to cause anything to be
  301.      aligned to a larger boundary than that.  For example, if  the
  302.      linker happens to put this object file at address 136 (eight more
  303.      than a multiple of 64), then the compiler cannot guarantee an
  304.      alignment of more than 8 just by aligning variables in the object
  305.      file.
  306. `mode (MODE)'
  307.      This attribute specifies the data type for the
  308.      declaration--whichever type corresponds to the mode MODE.  This in
  309.      effect lets you request an integer or floating point type
  310.      according to its width.
  311. `packed'
  312.      The `packed' attribute specifies that a variable or structure field
  313.      should have the smallest possible alignment--one byte for a
  314.      variable, and one bit for a field, unless you specify a larger
  315.      value with the `aligned' attribute.
  316.      Here is a structure in which the field `x' is packed, so that it
  317.      immediately follows `a':
  318.           struct foo
  319.           {
  320.             char a;
  321.             int x[2] __attribute__ ((packed));
  322.           };
  323. `section ("section-name")'
  324.      Normally, the compiler places the objects it generates in sections
  325.      like `data' and `bss'.  Sometimes, however, you need additional
  326.      sections, or you need certain particular variables to appear in
  327.      special sections, for example to map to special hardware.  The
  328.      `section' attribute specifies that a variable (or function) lives
  329.      in a particular section.  For example, this small program uses
  330.      several specific section names:
  331.           struct duart a __attribute__ ((section ("DUART_A"))) = { 0 };
  332.           struct duart b __attribute__ ((section ("DUART_B"))) = { 0 };
  333.           char stack[10000] __attribute__ ((section ("STACK"))) = { 0 };
  334.           int init_data_copy __attribute__ ((section ("INITDATACOPY"))) = 0;
  335.           
  336.           main()
  337.           {
  338.             /* Initialize stack pointer */
  339.             init_sp (stack + sizeof (stack));
  340.           
  341.             /* Initialize initialized data */
  342.             memcpy (&init_data_copy, &data, &edata - &data);
  343.           
  344.             /* Turn on the serial ports */
  345.             init_duart (&a);
  346.             init_duart (&b);
  347.           }
  348.      Use the `section' attribute with an *initialized* definition of a
  349.      *global* variable, as shown in the example.  GNU CC issues a
  350.      warning and otherwise ignores the `section' attribute in
  351.      uninitialized variable declarations.
  352.      You may only use the `section' attribute with a fully initialized
  353.      global definition because of the way linkers work.  The linker
  354.      requires each object be defined once, with the exception that
  355.      uninitialized variables tentatively go in the `common' (or `bss')
  356.      section and can be multiply "defined".
  357.      Some file formats do not support arbitrary sections so the
  358.      `section' attribute is not available on all platforms.  If you
  359.      need to map the entire contents of a module to a particular
  360.      section, consider using the facilities of the linker instead.
  361.    To specify multiple attributes, separate them by commas within the
  362. double parentheses: for example, `__attribute__ ((aligned (16),
  363. packed))'.
  364. File: gcc.info,  Node: Inline,  Next: Extended Asm,  Prev: Alignment,  Up: C Extensions
  365. An Inline Function is As Fast As a Macro
  366. ========================================
  367.    By declaring a function `inline', you can direct GNU CC to integrate
  368. that function's code into the code for its callers.  This makes
  369. execution faster by eliminating the function-call overhead; in
  370. addition, if any of the actual argument values are constant, their known
  371. values may permit simplifications at compile time so that not all of the
  372. inline function's code needs to be included.  The effect on code size is
  373. less predictable; object code may be larger or smaller with function
  374. inlining, depending on the particular case.  Inlining of functions is an
  375. optimization and it really "works" only in optimizing compilation.  If
  376. you don't use `-O', no function is really inline.
  377.    To declare a function inline, use the `inline' keyword in its
  378. declaration, like this:
  379.      inline int
  380.      inc (int *a)
  381.      {
  382.        (*a)++;
  383.      }
  384.    (If you are writing a header file to be included in ANSI C programs,
  385. write `__inline__' instead of `inline'.  *Note Alternate Keywords::.)
  386.    You can also make all "simple enough" functions inline with the
  387. option `-finline-functions'.  Note that certain usages in a function
  388. definition can make it unsuitable for inline substitution.
  389.    For C++ programs, GNU CC automatically inlines member functions even
  390. if they are not explicitly declared `inline'.  (You can override this
  391. with `-fno-default-inline'; *note Options Controlling C++ Dialect: C++
  392. Dialect Options..)
  393.    When a function is both inline and `static', if all calls to the
  394. function are integrated into the caller, and the function's address is
  395. never used, then the function's own assembler code is never referenced.
  396. In this case, GNU CC does not actually output assembler code for the
  397. function, unless you specify the option `-fkeep-inline-functions'.
  398. Some calls cannot be integrated for various reasons (in particular,
  399. calls that precede the function's definition cannot be integrated, and
  400. neither can recursive calls within the definition).  If there is a
  401. nonintegrated call, then the function is compiled to assembler code as
  402. usual.  The function must also be compiled as usual if the program
  403. refers to its address, because that can't be inlined.
  404.    When an inline function is not `static', then the compiler must
  405. assume that there may be calls from other source files; since a global
  406. symbol can be defined only once in any program, the function must not
  407. be defined in the other source files, so the calls therein cannot be
  408. integrated.  Therefore, a non-`static' inline function is always
  409. compiled on its own in the usual fashion.
  410.    If you specify both `inline' and `extern' in the function
  411. definition, then the definition is used only for inlining.  In no case
  412. is the function compiled on its own, not even if you refer to its
  413. address explicitly.  Such an address becomes an external reference, as
  414. if you had only declared the function, and had not defined it.
  415.    This combination of `inline' and `extern' has almost the effect of a
  416. macro.  The way to use it is to put a function definition in a header
  417. file with these keywords, and put another copy of the definition
  418. (lacking `inline' and `extern') in a library file.  The definition in
  419. the header file will cause most calls to the function to be inlined.
  420. If any uses of the function remain, they will refer to the single copy
  421. in the library.
  422.    GNU C does not inline any functions when not optimizing.  It is not
  423. clear whether it is better to inline or not, in this case, but we found
  424. that a correct implementation when not optimizing was difficult.  So we
  425. did the easy thing, and turned it off.
  426. File: gcc.info,  Node: Extended Asm,  Next: Asm Labels,  Prev: Inline,  Up: C Extensions
  427. Assembler Instructions with C Expression Operands
  428. =================================================
  429.    In an assembler instruction using `asm', you can now specify the
  430. operands of the instruction using C expressions.  This means no more
  431. guessing which registers or memory locations will contain the data you
  432. want to use.
  433.    You must specify an assembler instruction template much like what
  434. appears in a machine description, plus an operand constraint string for
  435. each operand.
  436.    For example, here is how to use the 68881's `fsinx' instruction:
  437.      asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
  438. Here `angle' is the C expression for the input operand while `result'
  439. is that of the output operand.  Each has `"f"' as its operand
  440. constraint, saying that a floating point register is required.  The `='
  441. in `=f' indicates that the operand is an output; all output operands'
  442. constraints must use `='.  The constraints use the same language used
  443. in the machine description (*note Constraints::.).
  444.    Each operand is described by an operand-constraint string followed
  445. by the C expression in parentheses.  A colon separates the assembler
  446. template from the first output operand, and another separates the last
  447. output operand from the first input, if any.  Commas separate output
  448. operands and separate inputs.  The total number of operands is limited
  449. to ten or to the maximum number of operands in any instruction pattern
  450. in the machine description, whichever is greater.
  451.    If there are no output operands, and there are input operands, then
  452. there must be two consecutive colons surrounding the place where the
  453. output operands would go.
  454.    Output operand expressions must be lvalues; the compiler can check
  455. this.  The input operands need not be lvalues.  The compiler cannot
  456. check whether the operands have data types that are reasonable for the
  457. instruction being executed.  It does not parse the assembler
  458. instruction template and does not know what it means, or whether it is
  459. valid assembler input.  The extended `asm' feature is most often used
  460. for machine instructions that the compiler itself does not know exist.
  461.    The output operands must be write-only; GNU CC will assume that the
  462. values in these operands before the instruction are dead and need not be
  463. generated.  Extended asm does not support input-output or read-write
  464. operands.  For this reason, the constraint character `+', which
  465. indicates such an operand, may not be used.
  466.    When the assembler instruction has a read-write operand, or an
  467. operand in which only some of the bits are to be changed, you must
  468. logically split its function into two separate operands, one input
  469. operand and one write-only output operand.  The connection between them
  470. is expressed by constraints which say they need to be in the same
  471. location when the instruction executes.  You can use the same C
  472. expression for both operands, or different expressions.  For example,
  473. here we write the (fictitious) `combine' instruction with `bar' as its
  474. read-only source operand and `foo' as its read-write destination:
  475.      asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
  476. The constraint `"0"' for operand 1 says that it must occupy the same
  477. location as operand 0.  A digit in constraint is allowed only in an
  478. input operand, and it must refer to an output operand.
  479.    Only a digit in the constraint can guarantee that one operand will
  480. be in the same place as another.  The mere fact that `foo' is the value
  481. of both operands is not enough to guarantee that they will be in the
  482. same place in the generated assembler code.  The following would not
  483. work:
  484.      asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
  485.    Various optimizations or reloading could cause operands 0 and 1 to
  486. be in different registers; GNU CC knows no reason not to do so.  For
  487. example, the compiler might find a copy of the value of `foo' in one
  488. register and use it for operand 1, but generate the output operand 0 in
  489. a different register (copying it afterward to `foo''s own address).  Of
  490. course, since the register for operand 1 is not even mentioned in the
  491. assembler code, the result will not work, but GNU CC can't tell that.
  492.    Some instructions clobber specific hard registers.  To describe
  493. this, write a third colon after the input operands, followed by the
  494. names of the clobbered hard registers (given as strings).  Here is a
  495. realistic example for the Vax:
  496.      asm volatile ("movc3 %0,%1,%2"
  497.                    : /* no outputs */
  498.                    : "g" (from), "g" (to), "g" (count)
  499.                    : "r0", "r1", "r2", "r3", "r4", "r5");
  500.    If you refer to a particular hardware register from the assembler
  501. code, then you will probably have to list the register after the third
  502. colon to tell the compiler that the register's value is modified.  In
  503. many assemblers, the register names begin with `%'; to produce one `%'
  504. in the assembler code, you must write `%%' in the input.
  505.    If your assembler instruction can alter the condition code register,
  506. add `cc' to the list of clobbered registers.  GNU CC on some machines
  507. represents the condition codes as a specific hardware register; `cc'
  508. serves to name this register.  On other machines, the condition code is
  509. handled differently, and specifying `cc' has no effect.  But it is
  510. valid no matter what the machine.
  511.    If your assembler instruction modifies memory in an unpredictable
  512. fashion, add `memory' to the list of clobbered registers.  This will
  513. cause GNU CC to not keep memory values cached in registers across the
  514. assembler instruction.
  515.    You can put multiple assembler instructions together in a single
  516. `asm' template, separated either with newlines (written as `\n') or with
  517. semicolons if the assembler allows such semicolons.  The GNU assembler
  518. allows semicolons and all Unix assemblers seem to do so.  The input
  519. operands are guaranteed not to use any of the clobbered registers, and
  520. neither will the output operands' addresses, so you can read and write
  521. the clobbered registers as many times as you like.  Here is an example
  522. of multiple instructions in a template; it assumes that the subroutine
  523. `_foo' accepts arguments in registers 9 and 10:
  524.      asm ("movl %0,r9;movl %1,r10;call _foo"
  525.           : /* no outputs */
  526.           : "g" (from), "g" (to)
  527.           : "r9", "r10");
  528.    Unless an output operand has the `&' constraint modifier, GNU CC may
  529. allocate it in the same register as an unrelated input operand, on the
  530. assumption that the inputs are consumed before the outputs are produced.
  531. This assumption may be false if the assembler code actually consists of
  532. more than one instruction.  In such a case, use `&' for each output
  533. operand that may not overlap an input.  *Note Modifiers::.
  534.    If you want to test the condition code produced by an assembler
  535. instruction, you must include a branch and a label in the `asm'
  536. construct, as follows:
  537.      asm ("clr %0;frob %1;beq 0f;mov #1,%0;0:"
  538.           : "g" (result)
  539.           : "g" (input));
  540. This assumes your assembler supports local labels, as the GNU assembler
  541. and most Unix assemblers do.
  542.    Speaking of labels, jumps from one `asm' to another are not
  543. supported.  The compiler's optimizers do not know about these jumps,
  544. and therefore they cannot take account of them when deciding how to
  545. optimize.
  546.    Usually the most convenient way to use these `asm' instructions is to
  547. encapsulate them in macros that look like functions.  For example,
  548.      #define sin(x)       \
  549.      ({ double __value, __arg = (x);   \
  550.         asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
  551.         __value; })
  552. Here the variable `__arg' is used to make sure that the instruction
  553. operates on a proper `double' value, and to accept only those arguments
  554. `x' which can convert automatically to a `double'.
  555.    Another way to make sure the instruction operates on the correct
  556. data type is to use a cast in the `asm'.  This is different from using a
  557. variable `__arg' in that it converts more different types.  For
  558. example, if the desired type were `int', casting the argument to `int'
  559. would accept a pointer with no complaint, while assigning the argument
  560. to an `int' variable named `__arg' would warn about using a pointer
  561. unless the caller explicitly casts it.
  562.    If an `asm' has output operands, GNU CC assumes for optimization
  563. purposes that the instruction has no side effects except to change the
  564. output operands.  This does not mean that instructions with a side
  565. effect cannot be used, but you must be careful, because the compiler
  566. may eliminate them if the output operands aren't used, or move them out
  567. of loops, or replace two with one if they constitute a common
  568. subexpression.  Also, if your instruction does have a side effect on a
  569. variable that otherwise appears not to change, the old value of the
  570. variable may be reused later if it happens to be found in a register.
  571.    You can prevent an `asm' instruction from being deleted, moved
  572. significantly, or combined, by writing the keyword `volatile' after the
  573. `asm'.  For example:
  574.      #define set_priority(x)  \
  575.      asm volatile ("set_priority %0": /* no outputs */ : "g" (x))
  576. An instruction without output operands will not be deleted or moved
  577. significantly, regardless, unless it is unreachable.
  578.    Note that even a volatile `asm' instruction can be moved in ways
  579. that appear insignificant to the compiler, such as across jump
  580. instructions.  You can't expect a sequence of volatile `asm'
  581. instructions to remain perfectly consecutive.  If you want consecutive
  582. output, use a single `asm'.
  583.    It is a natural idea to look for a way to give access to the
  584. condition code left by the assembler instruction.  However, when we
  585. attempted to implement this, we found no way to make it work reliably.
  586. The problem is that output operands might need reloading, which would
  587. result in additional following "store" instructions.  On most machines,
  588. these instructions would alter the condition code before there was time
  589. to test it.  This problem doesn't arise for ordinary "test" and
  590. "compare" instructions because they don't have any output operands.
  591.    If you are writing a header file that should be includable in ANSI C
  592. programs, write `__asm__' instead of `asm'.  *Note Alternate Keywords::.
  593. File: gcc.info,  Node: Asm Labels,  Next: Explicit Reg Vars,  Prev: Extended Asm,  Up: C Extensions
  594. Controlling Names Used in Assembler Code
  595. ========================================
  596.    You can specify the name to be used in the assembler code for a C
  597. function or variable by writing the `asm' (or `__asm__') keyword after
  598. the declarator as follows:
  599.      int foo asm ("myfoo") = 2;
  600. This specifies that the name to be used for the variable `foo' in the
  601. assembler code should be `myfoo' rather than the usual `_foo'.
  602.    On systems where an underscore is normally prepended to the name of
  603. a C function or variable, this feature allows you to define names for
  604. the linker that do not start with an underscore.
  605.    You cannot use `asm' in this way in a function *definition*; but you
  606. can get the same effect by writing a declaration for the function
  607. before its definition and putting `asm' there, like this:
  608.      extern func () asm ("FUNC");
  609.      
  610.      func (x, y)
  611.           int x, y;
  612.      ...
  613.    It is up to you to make sure that the assembler names you choose do
  614. not conflict with any other assembler symbols.  Also, you must not use a
  615. register name; that would produce completely invalid assembler code.
  616. GNU CC does not as yet have the ability to store static variables in
  617. registers.  Perhaps that will be added.
  618. File: gcc.info,  Node: Explicit Reg Vars,  Next: Alternate Keywords,  Prev: Asm Labels,  Up: C Extensions
  619. Variables in Specified Registers
  620. ================================
  621.    GNU C allows you to put a few global variables into specified
  622. hardware registers.  You can also specify the register in which an
  623. ordinary register variable should be allocated.
  624.    * Global register variables reserve registers throughout the program.
  625.      This may be useful in programs such as programming language
  626.      interpreters which have a couple of global variables that are
  627.      accessed very often.
  628.    * Local register variables in specific registers do not reserve the
  629.      registers.  The compiler's data flow analysis is capable of
  630.      determining where the specified registers contain live values, and
  631.      where they are available for other uses.
  632.      These local variables are sometimes convenient for use with the
  633.      extended `asm' feature (*note Extended Asm::.), if you want to
  634.      write one output of the assembler instruction directly into a
  635.      particular register.  (This will work provided the register you
  636.      specify fits the constraints specified for that operand in the
  637.      `asm'.)
  638. * Menu:
  639. * Global Reg Vars::
  640. * Local Reg Vars::
  641. File: gcc.info,  Node: Global Reg Vars,  Next: Local Reg Vars,  Up: Explicit Reg Vars
  642. Defining Global Register Variables
  643. ----------------------------------
  644.    You can define a global register variable in GNU C like this:
  645.      register int *foo asm ("a5");
  646. Here `a5' is the name of the register which should be used.  Choose a
  647. register which is normally saved and restored by function calls on your
  648. machine, so that library routines will not clobber it.
  649.    Naturally the register name is cpu-dependent, so you would need to
  650. conditionalize your program according to cpu type.  The register `a5'
  651. would be a good choice on a 68000 for a variable of pointer type.  On
  652. machines with register windows, be sure to choose a "global" register
  653. that is not affected magically by the function call mechanism.
  654.    In addition, operating systems on one type of cpu may differ in how
  655. they name the registers; then you would need additional conditionals.
  656. For example, some 68000 operating systems call this register `%a5'.
  657.    Eventually there may be a way of asking the compiler to choose a
  658. register automatically, but first we need to figure out how it should
  659. choose and how to enable you to guide the choice.  No solution is
  660. evident.
  661.    Defining a global register variable in a certain register reserves
  662. that register entirely for this use, at least within the current
  663. compilation.  The register will not be allocated for any other purpose
  664. in the functions in the current compilation.  The register will not be
  665. saved and restored by these functions.  Stores into this register are
  666. never deleted even if they would appear to be dead, but references may
  667. be deleted or moved or simplified.
  668.    It is not safe to access the global register variables from signal
  669. handlers, or from more than one thread of control, because the system
  670. library routines may temporarily use the register for other things
  671. (unless you recompile them specially for the task at hand).
  672.    It is not safe for one function that uses a global register variable
  673. to call another such function `foo' by way of a third function `lose'
  674. that was compiled without knowledge of this variable (i.e. in a
  675. different source file in which the variable wasn't declared).  This is
  676. because `lose' might save the register and put some other value there.
  677. For example, you can't expect a global register variable to be
  678. available in the comparison-function that you pass to `qsort', since
  679. `qsort' might have put something else in that register.  (If you are
  680. prepared to recompile `qsort' with the same global register variable,
  681. you can solve this problem.)
  682.    If you want to recompile `qsort' or other source files which do not
  683. actually use your global register variable, so that they will not use
  684. that register for any other purpose, then it suffices to specify the
  685. compiler option `-ffixed-REG'.  You need not actually add a global
  686. register declaration to their source code.
  687.    A function which can alter the value of a global register variable
  688. cannot safely be called from a function compiled without this variable,
  689. because it could clobber the value the caller expects to find there on
  690. return.  Therefore, the function which is the entry point into the part
  691. of the program that uses the global register variable must explicitly
  692. save and restore the value which belongs to its caller.
  693.    On most machines, `longjmp' will restore to each global register
  694. variable the value it had at the time of the `setjmp'.  On some
  695. machines, however, `longjmp' will not change the value of global
  696. register variables.  To be portable, the function that called `setjmp'
  697. should make other arrangements to save the values of the global register
  698. variables, and to restore them in a `longjmp'.  This way, the same
  699. thing will happen regardless of what `longjmp' does.
  700.    All global register variable declarations must precede all function
  701. definitions.  If such a declaration could appear after function
  702. definitions, the declaration would be too late to prevent the register
  703. from being used for other purposes in the preceding functions.
  704.    Global register variables may not have initial values, because an
  705. executable file has no means to supply initial contents for a register.
  706.    On the Sparc, there are reports that g3 ... g7 are suitable
  707. registers, but certain library functions, such as `getwd', as well as
  708. the subroutines for division and remainder, modify g3 and g4.  g1 and
  709. g2 are local temporaries.
  710.    On the 68000, a2 ... a5 should be suitable, as should d2 ... d7.  Of
  711. course, it will not do to use more than a few of those.
  712. File: gcc.info,  Node: Local Reg Vars,  Prev: Global Reg Vars,  Up: Explicit Reg Vars
  713. Specifying Registers for Local Variables
  714. ----------------------------------------
  715.    You can define a local register variable with a specified register
  716. like this:
  717.      register int *foo asm ("a5");
  718. Here `a5' is the name of the register which should be used.  Note that
  719. this is the same syntax used for defining global register variables,
  720. but for a local variable it would appear within a function.
  721.    Naturally the register name is cpu-dependent, but this is not a
  722. problem, since specific registers are most often useful with explicit
  723. assembler instructions (*note Extended Asm::.).  Both of these things
  724. generally require that you conditionalize your program according to cpu
  725. type.
  726.    In addition, operating systems on one type of cpu may differ in how
  727. they name the registers; then you would need additional conditionals.
  728. For example, some 68000 operating systems call this register `%a5'.
  729.    Eventually there may be a way of asking the compiler to choose a
  730. register automatically, but first we need to figure out how it should
  731. choose and how to enable you to guide the choice.  No solution is
  732. evident.
  733.    Defining such a register variable does not reserve the register; it
  734. remains available for other uses in places where flow control determines
  735. the variable's value is not live.  However, these registers are made
  736. unavailable for use in the reload pass.  I would not be surprised if
  737. excessive use of this feature leaves the compiler too few available
  738. registers to compile certain functions.
  739. File: gcc.info,  Node: Alternate Keywords,  Next: Incomplete Enums,  Prev: Explicit Reg Vars,  Up: C Extensions
  740. Alternate Keywords
  741. ==================
  742.    The option `-traditional' disables certain keywords; `-ansi'
  743. disables certain others.  This causes trouble when you want to use GNU C
  744. extensions, or ANSI C features, in a general-purpose header file that
  745. should be usable by all programs, including ANSI C programs and
  746. traditional ones.  The keywords `asm', `typeof' and `inline' cannot be
  747. used since they won't work in a program compiled with `-ansi', while
  748. the keywords `const', `volatile', `signed', `typeof' and `inline' won't
  749. work in a program compiled with `-traditional'.
  750.    The way to solve these problems is to put `__' at the beginning and
  751. end of each problematical keyword.  For example, use `__asm__' instead
  752. of `asm', `__const__' instead of `const', and `__inline__' instead of
  753. `inline'.
  754.    Other C compilers won't accept these alternative keywords; if you
  755. want to compile with another compiler, you can define the alternate
  756. keywords as macros to replace them with the customary keywords.  It
  757. looks like this:
  758.      #ifndef __GNUC__
  759.      #define __asm__ asm
  760.      #endif
  761.    `-pedantic' causes warnings for many GNU C extensions.  You can
  762. prevent such warnings within one expression by writing `__extension__'
  763. before the expression.  `__extension__' has no effect aside from this.
  764. File: gcc.info,  Node: Incomplete Enums,  Next: Function Names,  Prev: Alternate Keywords,  Up: C Extensions
  765. Incomplete `enum' Types
  766. =======================
  767.    You can define an `enum' tag without specifying its possible values.
  768. This results in an incomplete type, much like what you get if you write
  769. `struct foo' without describing the elements.  A later declaration
  770. which does specify the possible values completes the type.
  771.    You can't allocate variables or storage using the type while it is
  772. incomplete.  However, you can work with pointers to that type.
  773.    This extension may not be very useful, but it makes the handling of
  774. `enum' more consistent with the way `struct' and `union' are handled.
  775. File: gcc.info,  Node: Function Names,  Prev: Incomplete Enums,  Up: C Extensions
  776. Function Names as Strings
  777. =========================
  778.    GNU CC predefines two string variables to be the name of the current
  779. function.  The variable `__FUNCTION__' is the name of the function as
  780. it appears in the source.  The variable `__PRETTY_FUNCTION__' is the
  781. name of the function pretty printed in a language specific fashion.
  782.    These names are always the same in a C function, but in a C++
  783. function they may be different.  For example, this program:
  784.      extern "C" {
  785.      extern int printf (char *, ...);
  786.      }
  787.      
  788.      class a {
  789.       public:
  790.        sub (int i)
  791.          {
  792.            printf ("__FUNCTION__ = %s\n", __FUNCTION__);
  793.            printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
  794.          }
  795.      };
  796.      
  797.      int
  798.      main (void)
  799.      {
  800.        a ax;
  801.        ax.sub (0);
  802.        return 0;
  803.      }
  804. gives this output:
  805.      __FUNCTION__ = sub
  806.      __PRETTY_FUNCTION__ = int  a::sub (int)
  807. File: gcc.info,  Node: C++ Extensions,  Next: Trouble,  Prev: C Extensions,  Up: Top
  808. Extensions to the C++ Language
  809. ******************************
  810.    The GNU compiler provides these extensions to the C++ language (and
  811. you can also use most of the C language extensions in your C++
  812. programs).  If you want to write code that checks whether these
  813. features are available, you can test for the GNU compiler the same way
  814. as for C programs: check for a predefined macro `__GNUC__'.  You can
  815. also use `__GNUG__' to test specifically for GNU C++ (*note Standard
  816. Predefined Macros: (cpp.info)Standard Predefined.).
  817. * Menu:
  818. * Naming Results::      Giving a name to C++ function return values.
  819. * Min and Max::        C++ Minimum and maximum operators.
  820. * Destructors and Goto:: Goto is safe to use in C++ even when destructors
  821.                            are needed.
  822. * C++ Interface::       You can use a single C++ header file for both
  823.                          declarations and definitions.
  824. * C++ Signatures::    You can specify abstract types to get subtype
  825.              polymorphism independent from inheritance.
  826. File: gcc.info,  Node: Naming Results,  Next: Min and Max,  Up: C++ Extensions
  827. Named Return Values in C++
  828. ==========================
  829.    GNU C++ extends the function-definition syntax to allow you to
  830. specify a name for the result of a function outside the body of the
  831. definition, in C++ programs:
  832.      TYPE
  833.      FUNCTIONNAME (ARGS) return RESULTNAME;
  834.      {
  835.        ...
  836.        BODY
  837.        ...
  838.      }
  839.    You can use this feature to avoid an extra constructor call when a
  840. function result has a class type.  For example, consider a function
  841. `m', declared as `X v = m ();', whose result is of class `X':
  842.      X
  843.      m ()
  844.      {
  845.        X b;
  846.        b.a = 23;
  847.        return b;
  848.      }
  849.    Although `m' appears to have no arguments, in fact it has one
  850. implicit argument: the address of the return value.  At invocation, the
  851. address of enough space to hold `v' is sent in as the implicit argument.
  852. Then `b' is constructed and its `a' field is set to the value 23.
  853. Finally, a copy constructor (a constructor of the form `X(X&)') is
  854. applied to `b', with the (implicit) return value location as the
  855. target, so that `v' is now bound to the return value.
  856.    But this is wasteful.  The local `b' is declared just to hold
  857. something that will be copied right out.  While a compiler that
  858. combined an "elision" algorithm with interprocedural data flow analysis
  859. could conceivably eliminate all of this, it is much more practical to
  860. allow you to assist the compiler in generating efficient code by
  861. manipulating the return value explicitly, thus avoiding the local
  862. variable and copy constructor altogether.
  863.    Using the extended GNU C++ function-definition syntax, you can avoid
  864. the temporary allocation and copying by naming `r' as your return value
  865. as the outset, and assigning to its `a' field directly:
  866.      X
  867.      m () return r;
  868.      {
  869.        r.a = 23;
  870.      }
  871. The declaration of `r' is a standard, proper declaration, whose effects
  872. are executed *before* any of the body of `m'.
  873.    Functions of this type impose no additional restrictions; in
  874. particular, you can execute `return' statements, or return implicitly by
  875. reaching the end of the function body ("falling off the edge").  Cases
  876.      X
  877.      m () return r (23);
  878.      {
  879.        return;
  880.      }
  881. (or even `X m () return r (23); { }') are unambiguous, since the return
  882. value `r' has been initialized in either case.  The following code may
  883. be hard to read, but also works predictably:
  884.      X
  885.      m () return r;
  886.      {
  887.        X b;
  888.        return b;
  889.      }
  890.    The return value slot denoted by `r' is initialized at the outset,
  891. but the statement `return b;' overrides this value.  The compiler deals
  892. with this by destroying `r' (calling the destructor if there is one, or
  893. doing nothing if there is not), and then reinitializing `r' with `b'.
  894.    This extension is provided primarily to help people who use
  895. overloaded operators, where there is a great need to control not just
  896. the arguments, but the return values of functions.  For classes where
  897. the copy constructor incurs a heavy performance penalty (especially in
  898. the common case where there is a quick default constructor), this is a
  899. major savings.  The disadvantage of this extension is that you do not
  900. control when the default constructor for the return value is called: it
  901. is always called at the beginning.
  902. File: gcc.info,  Node: Min and Max,  Next: Destructors and Goto,  Prev: Naming Results,  Up: C++ Extensions
  903. Minimum and Maximum Operators in C++
  904. ====================================
  905.    It is very convenient to have operators which return the "minimum"
  906. or the "maximum" of two arguments.  In GNU C++ (but not in GNU C),
  907. `A <? B'
  908.      is the "minimum", returning the smaller of the numeric values A
  909.      and B;
  910. `A >? B'
  911.      is the "maximum", returning the larger of the numeric values A and
  912.      B.
  913.    These operations are not primitive in ordinary C++, since you can
  914. use a macro to return the minimum of two things in C++, as in the
  915. following example.
  916.      #define MIN(X,Y) ((X) < (Y) ? : (X) : (Y))
  917. You might then use `int min = MIN (i, j);' to set MIN to the minimum
  918. value of variables I and J.
  919.    However, side effects in `X' or `Y' may cause unintended behavior.
  920. For example, `MIN (i++, j++)' will fail, incrementing the smaller
  921. counter twice.  A GNU C extension allows you to write safe macros that
  922. avoid this kind of problem (*note Naming an Expression's Type: Naming
  923. Types.).  However, writing `MIN' and `MAX' as macros also forces you to
  924. use function-call notation notation for a fundamental arithmetic
  925. operation.  Using GNU C++ extensions, you can write `int min = i <? j;'
  926. instead.
  927.    Since `<?' and `>?' are built into the compiler, they properly
  928. handle expressions with side-effects;  `int min = i++ <? j++;' works
  929. correctly.
  930. File: gcc.info,  Node: Destructors and Goto,  Next: C++ Interface,  Prev: Min and Max,  Up: C++ Extensions
  931. `goto' and Destructors in GNU C++
  932. =================================
  933.    In C++ programs, you can safely use the `goto' statement.  When you
  934. use it to exit a block which contains aggregates requiring destructors,
  935. the destructors will run before the `goto' transfers control.  (In ANSI
  936. C++, `goto' is restricted to targets within the current block.)
  937.    The compiler still forbids using `goto' to *enter* a scope that
  938. requires constructors.
  939.